/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.impl.cfg.multitenant;

import java.util.Collection;


/**
 * Interface to be implemented when using the {@link MultiSchemaMultiTenantProcessEngineConfiguration} and used
 * to set/get the current user and tenant identifier.
 * <p>
 * The engine will call the {@link #getCurrentTenantId()} method when it needs to know which database to use.
 * <p>
 * Typically used with {@link ThreadLocal}'s in the implementation.
 *
 * @deprecated multi-tenant code will be removed in future version of Activiti and Activiti Cloud
 */
@Deprecated
public interface TenantInfoHolder {

    /**
     * Returns all known tenant identifiers.
     */
    Collection<String> getAllTenants();

    /**
     * Sets the current tenant identifier.
     */
    void setCurrentTenantId(String tenantid);

    /**
     * Returns the current tenant identifier.
     */
    String getCurrentTenantId();

    /**
     * Clears the current tenant identifier settings.
     */
    void clearCurrentTenantId();

}
